home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / tcnbp2o3.zip / MM10.DOC < prev    next >
Text File  |  1992-08-08  |  15KB  |  463 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.      NOTE:  For best results, perform Main Menu option 10 immediately after
  8.      starting the program (before performing any other function).  If you use
  9.      Main Menu option 10 on two files back-to-back, restart the program between
  10.      the two files.  If you fail to do this, and the file that is analyzed is
  11.      smaller than the selected version or portion or smaller than the
  12.      previously analyzed file, subsequent attempts to display phrases and text
  13.      near the end of a version or portion may result in errors.
  14.  
  15.  
  16.  
  17.      MAIN MENU OPTION 10, ANALYZING (PARSING) A SOURCE FILE
  18.  
  19.  
  20.      This file contains information needed to parse a file using Main Menu
  21.      option 10.  In addition to the task oriented instructions needed to
  22.      complete the analysis dialogue, information of a general nature is
  23.      included to guide you through the entire process.
  24.  
  25.  
  26.      Major steps involved in analyzing a file are:
  27.  
  28.  
  29.      1)  Source file preparation.
  30.  
  31.      The content of your source file depends on your objective for performing
  32.      the analysis.  The source file is prepared using your word processor.
  33.      Save your file in a mode that does not insert special codes in the file.
  34.      Files in this format are generally described as ASCII files.  All provided
  35.      files are such files.  Main Menu option 10 works fine with them.  Using
  36.      Main Menu option 10 with files containing special codes (not ASCII) may
  37.      produce unreliable results.  Refer to modification of source file for
  38.      further information.
  39.  
  40.      Check your source file very carefully.  Once you analyze it, you are stuck
  41.      with the results of the analysis.  You cannot delete it.  There is a
  42.      practical limit of 30 (approximately) sets of output that can be
  43.      accommodated by this program.
  44.  
  45.  
  46.      2)  Diskette preparation.
  47.  
  48.      If you intend to save your output on diskette, or use the diskette drives
  49.      to store your source file during the analysis, you must have the diskettes
  50.      ready before you can start the analysis function dialogue.  As you proceed
  51.      through the dialogue, the program checks your information against the
  52.      diskettes in the drive.  This ensures that all required information is
  53.      available.  If not, at least you haven't tied up your computer for the
  54.      time required to parse the file for nothing.
  55.  
  56.  
  57.  
  58.  
  59.  
  60.                                             65
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.      Know what will be on each diskette and have the source file stored where
  74.      you intend to parse it from before starting the program.  If need be,
  75.      format a diskette or two and label it (them) first.
  76.  
  77.      If you are storing more than one set of output on a diskette, check the
  78.      available space on the diskette that you will use to store your output.
  79.      The program does not do this.  Be sure that the diskette has enough room
  80.      for the automatically generated output files and enough room to store the
  81.      amount of cross references and comments that you estimate you will
  82.      generate.  For further information see DETAILED INFORMATION ABOUT DISK
  83.      SPACE REQUIREMENTS in the file DISKROOM.DOC.
  84.  
  85.      If you are working on a computer that has only one diskette drive and no
  86.      fixed drive, your source file must be stored on the same diskette where
  87.      the output files will be stored.  This limits one diskette users to 1
  88.      (maximum) analysis of the complete Constitution with all amendments per
  89.      360 K 5.25-inch diskette.  There simply is not room for the source file
  90.      and 2 sets of outputs.  After completing option 10, you can delete the
  91.      source file from the diskette if need be to free up space.  The program
  92.      does not use the source file except during option 10.
  93.  
  94.  
  95.      3)  Analysis dialogue.
  96.  
  97.      The analysis dialogue begins after you select Main Menu option 10.  You
  98.      are prompted for information in a series of prompts.  As you enter each
  99.      item of information, the program checks the information against available
  100.      files on diskette or the fixed drive.  If a problem is detected, prompts
  101.      appear to alert you and give hints at solutions.  The  information entered
  102.      during the analysis dialogue is used by the computer during analysis to
  103.      locate required information and to decide where to store the output.
  104.      Also, this information is saved for display during execution of Main Menu
  105.      option 2.  You are provided an opportunity during the analysis dialogue to
  106.      enter comments (60 characters).
  107.  
  108.      The analysis dialogue provides a measure of confidence that all required
  109.      files are available before starting the actual analysis.  One thing that
  110.      the dialogue will not detect is when single diskette users have the source
  111.      file and output files on separate diskettes.  Remember, single diskette
  112.      users with no fixed drive, the source file must be on the same diskette
  113.      where you intend the output to be stored.  Otherwise, you will get a fatal
  114.      error or totally erroneous output.  Another thing the program does not
  115.      check is whether the Constitution file is on the Program Diskette.  NEVER
  116.      do this.
  117.  
  118.  
  119.      4)  Analysis.
  120.  
  121.      The program parses the file and generates 28 files that contain the
  122.      indexes used to display and cross reference information.  The screen
  123.      usually has something displayed on it to give you an idea that something
  124.  
  125.  
  126.                                             66
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.      is happening so you can know that you computer is not locked up.  You
  140.      might be prompted to insert the program diskette or the diskette with the
  141.      source file.  If prompted to insert the program diskette (this prompt will
  142.      not appear if you installed on a fixed drive), put the program diskette in
  143.      the drive where you installed.  If you put it in another drive, the prompt
  144.      will be repeated until you put it in the proper drive.  If prompted to
  145.      insert the diskette with the source file, insert it in the drive that you
  146.      indicated during the analysis dialogue.  If you put it in another drive,
  147.      the prompt is repeated until you put it in the appropriate drive.
  148.  
  149.      If a message appears advising you to print the screen, a fatal error has
  150.      occurred.  This is possible due to the wide variations occurring in user
  151.      preparation of the source file.  If this happens, send your screen print
  152.      out and a copy (on diskette) of your source file to the address provided
  153.      by Main Menu option 14 for advice concerning a solution.
  154.  
  155.  
  156.  
  157.      Analysis Dialogue
  158.  
  159.  
  160.      The same series of prompts is displayed for all diskette, diskette
  161.      plus fixed drive, or fixed drive combinations during the analysis
  162.      dialogue.  Depending on the combination of disk drives that you have or
  163.      are using, your responses vary.  Each response is checked for validity
  164.      before proceeding to the next prompt.  Each prompt is repeated until
  165.      acceptable input is provided.  The following materials describe each
  166.      prompt, valid responses and error correction for the analysis dialogue.
  167.  
  168.  
  169.      1)  Source Text File Drive Specifier Prompt.
  170.  
  171.      You are prompted for the drive specifier that indicates on which drive
  172.      the text source file will be stored during analysis.
  173.  
  174.          a)  Type an upper or lower case letter A - Z.
  175.  
  176.          b)  Press ENTER.
  177.  
  178.          The program checks to see if the drive you specified is available.
  179.          A formatted diskette must be in the drive if a floppy is specified.
  180.  
  181.          If the drive is unavailable, an advisory message appears to that
  182.          effect, and solutions are given.  The prompt is repeated.
  183.  
  184.          If the drive is available, the next prompt appears.
  185.  
  186.      
  187.  
  188.  
  189.  
  190.  
  191.  
  192.                                             67
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.      2)  Source Text File Path Information Prompt
  206.  
  207.      You are prompted for the path on which the source file is stored during
  208.      analysis.  A colon and backslash are automatically added to the drive
  209.      specifier previously entered.
  210.  
  211.          a)  Type the rest of the path information.  If the source file is
  212.          stored in the root directory, do not type anything.
  213.  
  214.          b)  Press ENTER.
  215.  
  216.          The program checks to see if the path you specified exists.
  217.  
  218.          If the path does not exist, an advisory message appears to that
  219.          effect, and solutions are given.  The prompt is repeated.
  220.  
  221.          If the path exists, the next prompt appears.
  222.  
  223.  
  224.      3)  Source Text File Name Prompt.
  225.  
  226.      You are prompted for the file name of the source file.
  227.  
  228.          a)  Type in the source file name and extension.
  229.  
  230.          b)  Press ENTER.
  231.  
  232.          The program checks to see if the file exists on the path
  233.          previously entered.
  234.  
  235.          If the file does not exist, an advisory message appears to that
  236.          effect and solutions are given.  The prompt is repeated.
  237.  
  238.          If the file exists, the next prompt appears.
  239.  
  240.  
  241.      4)  Output Drive Prompt.
  242.  
  243.      You are prompted for the drive specifier that indicates on which drive the
  244.      output files will be stored.
  245.  
  246.          a)  Type an upper or lower case letter A - Z.
  247.  
  248.          b)  Press ENTER.
  249.  
  250.          The program checks to see if the drive you specified is available.  A
  251.          formatted diskette must be in the drive if a floppy is specified.
  252.  
  253.          If the drive is unavailable, an advisory message appears to that
  254.          effect, and solutions are given.  The prompt is repeated.
  255.  
  256.  
  257.  
  258.                                             68
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.          If the drive is available, the next prompt appears.
  272.  
  273.  
  274.      5)  Output Path Prompt.
  275.  
  276.      You are prompted for the path on which the output files are to be stored
  277.      by analysis.  A colon and backslash are automatically added to the drive
  278.      specifier previously entered.
  279.  
  280.          a)  Type the rest of the path information.
  281.  
  282.          If the output is to be stored in the root directory, do not type
  283.          anything.  However, if you are using a fixed drive, or if you are
  284.          storing the output of more than one analysis on a floppy diskette, you
  285.          must not specify the root directory for more than one analysis.
  286.          Otherwise, the results of the previous analysis will be lost.  A
  287.          simple rule is: ALWAYS specify a unique path.  Never store output in
  288.          the root directory on any drive or any diskette.
  289.  
  290.          b)  Press ENTER.
  291.  
  292.          The program checks to see if the path you specified exists.
  293.  
  294.          If the path does not exist, an advisory message appears to that
  295.          effect, and solutions are given.  The prompt is repeated.
  296.  
  297.          If the path exists, the program checks to see if the path has been
  298.          used for analysis previously.  If so, an advisory message appears to
  299.          that effect, and you are given the option to continue or escape.  If
  300.          you continue, the results of the previous analysis are lost.  If you
  301.          escape, you can repeat the analysis dialogue and enter different path
  302.          information.
  303.  
  304.          When all checks have been completed, the next prompt appears.
  305.  
  306.      6)  Comments Prompt.
  307.  
  308.      You are prompted for 60 characters of comments.
  309.  
  310.          a)  Type your comments, if any.
  311.  
  312.          The left and right arrow keys, DELETE, and F9 keys are active.
  313.  
  314.          The source file name, source file path, the output file path
  315.          information that you entered previously during this dialogue is stored
  316.          for recall during Main Menu option 2.  Your comments need not repeat
  317.          this information.  Use the comments to reference another file or
  318.          perhaps a notebook that contains more detailed information about the
  319.          reasons for this analysis.  Or briefly describe the source file as was
  320.          done with the provided analysis.
  321.  
  322.  
  323.  
  324.                                             69
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.          b)  Press ENTER.
  338.  
  339.          No checks are performed.  The program proceeds to the actual analysis
  340.          of the source file.
  341.  
  342.  
  343.  
  344.      Analysis of the Source File
  345.  
  346.  
  347.      Following completion of the analysis dialogue, the program reads the
  348.      master sort data.  If you are working from diskette, you may be prompted
  349.      to insert the program diskette.  If so, insert it in the drive that you
  350.      installed to.
  351.  
  352.      After reading the master sort data, the program attempts to access the
  353.      source file.  If it is not available, you are prompted to insert the
  354.      appropriate diskette.  Insert the diskette in the drive you indicated
  355.      during the analysis dialogue.
  356.  
  357.      When analysis begins, the 200 bytes of text that is being parsed is
  358.      displayed at the top of the screen.  This display (as well as the others)
  359.      was placed in the code to aid in de-bugging while the program was being
  360.      written.  It was left in the code for two reasons.  One reason is so your
  361.      screen won't sit idle for an extended period while analysis is performed.
  362.      The other reason is to provide helpful information should bugs appear in
  363.      use when the Constitution is amended or when you analyze modified files.
  364.  
  365.      If your modified version contains words not previously used in the
  366.      provided files, you may be prompted to insert the program diskette during
  367.      analysis (if you are working from diskettes).  If so, place the working
  368.      copy of the program diskette in the drive that you installed to.
  369.  
  370.  
  371.      NOTE:  This process updates the master vocabulary list.  Never write the
  372.      updated list to the backup diskette or to the original.  Write the updated
  373.      list to your working copy if you are using diskettes.  To avoid saving the
  374.      updated list on the original or backup copy, always protect those copies
  375.      by leaving the write protect tab in place for 5.25 inch diskettes or
  376.      always leaving the write protect tab on 3.5 inch diskettes in the protect
  377.      position.  Each time your master vocabulary list is updated, backup your
  378.      master vocabulary list.  The program does not do this, nor does it remind
  379.      you to do it.  See BACKUP.DOC.
  380.  
  381.  
  382.      The remainder of the prompts that appear on the screen during analysis are
  383.      of no interest except that they should always be changing at least once
  384.      every 5 minutes.  If not, the program is locked up.
  385.  
  386.      When analysis is complete, you may be prompted to insert the program
  387.      diskette and then the index (output) diskette.  If so, insert the
  388.  
  389.  
  390.                                             70
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.      diskettes in the appropriate drive (install drive for program diskette,
  404.      drive you specified during analysis dialogue for index diskette).  After
  405.      these two prompts, you are returned to the Main Menu and the results of
  406.      your analysis are now available for review.
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.                                             71
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.